@opentelemetry/metrics

OpenTelemetry Metrics SDK

OpenTelemetry metrics allow a user to collect data and export it to a metrics backend like Prometheus.

Installation

npm install --save @opentelemetry/metrics

Usage

Counter

Choose this kind of metric when the value is a quantity, the sum is of primary interest, and the event count and value distribution are not of primary interest. Counters are defined as Monotonic = true by default, meaning that positive values are expected.

const { MeterProvider } = require('@opentelemetry/metrics');

// Initialize the Meter to capture measurements in various ways.
const meter = new MeterProvider().getMeter('your-meter-name');

const counter = meter.createCounter('metric_name', {
  labelKeys: ["pid"],
  description: "Example of a counter"
});

const labels = meter.labels({ pid: process.pid });

// Create a BoundInstrument associated with specified label values.
const boundCounter = counter.bind(labels);
boundCounter.add(10);

See examples/prometheus for a short example.

Measure

Work in progress

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
• For help or feedback on this project, join us on gitter

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.5.2

Released 2020-03-27

:rocket: (Enhancement)

• opentelemetry-exporter-prometheus, opentelemetry-metrics
  • #893 Metrics: Add lastUpdateTimestamp associated with point (@mayurkale22)
• opentelemetry-tracing
  • #896 Do not export empty span lists (@dyladan)
• opentelemetry-api, opentelemetry-tracing
  • #889 feat: start a root span with spanOptions.parent = null (@dyladan)

:bug: (Bug Fix)

• opentelemetry-core, opentelemetry-propagator-jaeger
  • #904 fix: add type checking in propagators (@dyladan)
• opentelemetry-context-base, opentelemetry-core, opentelemetry-plugin-document-load, opentelemetry-plugin-user-interaction, opentelemetry-web
  • #906 chore: fixing documentation for web tracer provider, fixing examples … (@obecny)
• Other
  • #884 chore: fixing main package.json version (@obecny)

:books: (Refine Doc)

• opentelemetry-context-base, opentelemetry-core, opentelemetry-plugin-document-load, opentelemetry-plugin-user-interaction, opentelemetry-web
  • #906 chore: fixing documentation for web tracer provider, fixing examples … (@obecny)

Committers: 4

• Bartlomiej Obecny (@obecny)
• Daniel Dyla (@dyladan)
• Mark Robert Henderson (@aphelionz)
• Mayur Kale (@mayurkale22)